Crate hff_std

Implements the basic reader/writer functionality for HFF.

Re-exports

• pub use hff_core;

Modules

• utilities
  Simple helpers for working with Hff data, primarilly metadata.

Structs

• ChunkCache
  Act as a ReadSeek IO object for purposes of having an entire HFF in memory at one time.
• ChunkDesc
  An intermediate chunk description.
• ChunkView
  A view to a chunk.
• Ecc
  8 character code.
• Hff
  The Hff structure data. This is an immutable representation of the content of an Hff stream.
• HffDesc
  Description of hff and content.
• StdReader
  Implements a std reader wrapper around the source.
• TableBuilder
  Builder for tables.
• TableView
  View of a table.
• Version
  Version of the file format.

Enums

• DataSource
  The source of data for given metadata or chunk.
• Error
  Common error type.
• IdType
  Identifier type as specified in the hff header. This has no impact on behavior at all, it is only a hint to the end user about how to use/view the ID’s.

Traits

• ByteOrder
  ByteOrder describes types that can serialize integers as bytes.
• ContentInfo
  Information about the metadata or chunk data contained within the source.
• ReadSeek
  A wrapper trait with a blanket implementation for any type which supports both Read and Seek. The data source of the Hff must support this in order to retrieve metadata or chunk’s from the stream. If the stream is not Seek, either use the provided _full variation which will return the ChunkCache or otherwise store the entire file somewhere which can be accessed with Seek.
• WriteSeek
  Helper trait for lazy writing.
• Writer
  Writer trait for HffDesc.

Functions

• build
  Create a new builder instance.
• chunk
  Build a new chunk.
• hff
  Build the structure of the Hff content.
• inspect
  Read the structure of a Hff into memory. Provides access only to the structure without any of the metadata or chunk data available.
• open
  Opens the input and maintains it for random access to the metadata and chunks.
• read
  Reads an entire Hff into memory.
• table
  Start building a new table.

Type Aliases

• BE
  Big Endian.
• LE
  Little Endian.
• NE
  Native Endian.
• OP
  Opposing Endian.
• Result
  The standard result type used in the crate.